Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: improve doc/markdown file organization coherence #31771

Closed
wants to merge 36 commits into from

Conversation

DavenportEmma
Copy link
Contributor

Improve markdown and documentation file organization.

Fixes: #31741

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Merged the CODE_OF_CONDUCT.md and doc/guides/contributing/coc.md
files into a single code of conduct file

Refs: nodejs#31741
Changed security_release_process.md to security-release-process.md
to stay consistent with file naming

Refs: nodejs#31741
Moved writing-and-running-benchmarks to doc/guides/ directory

Fixes: nodejs#31741
Updated updating-root-certs.md to maintaining-root-certs.md

Fixes: nodejs#31741
Moved COLLABORATOR_GUIDE, CPP_STYLE_GUIDE, and internal-api to
the appropriate directories

Fixes: nodejs#31741
Moved STYLE_GUIDE.md to guides/documentation-style.md

Fixes: nodejs#31741
Updated broken links after merging doc/guides/contributing/coc.md
@nodejs-github-bot nodejs-github-bot added the meta Issues and PRs related to the general management of the project. label Feb 13, 2020
Copy link
Member

@richardlau richardlau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A quick search for writing-and-running-benchmarks shows that the current location is referenced elsewhere so moving the file will break those links unless they are also updated.

The same applies to CPP_STYLE_GUIDE and COLLABORATOR_GUIDE.

tniessen and others added 15 commits February 13, 2020 21:12
PR-URL: nodejs#31719
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Add more information about why it is advisable not to use
`.FromJust()` etc. on Maybe(Local)s, and general information
about termination exceptions.

PR-URL: nodejs#31720
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Moves directions for LTS release from the Release repo to Node docs.

Fixes: nodejs/Release#530
PR-URL: nodejs#31724
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Remove magic number and measure amount of difference should be allowable
between consecutive stat() calls.

PR-URL: nodejs#31726
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Two scenarios should be tested:

1. The completion is triggered and the result is printed before the
   next invocation.
2. The completion is triggered multiple times right after each other
   without waiting for the result. In that case only the last result
   should be printed.

The first scenario did not need a timeout while the latter did not
need a timeout for the second invocation.

PR-URL: nodejs#31708
Fixes: nodejs#31094
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#31705
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Was resolved in nodejs@e559842.

PR-URL: nodejs#31701
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#31692
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Update my personal email address from usharma1998@gmail.com (tired)
to ryzokuken@disroot.org (wired).

PR-URL: nodejs#31670
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
PR-URL: nodejs#31620
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#31662
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Add prerequisites for Arch Linux and derivatives in BUILDING.md.

PR-URL: nodejs#31669
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
In benchmark directory this changes for loops
using var to let when it applies for consistency

PR-URL: nodejs#28958
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Use `let` in module, napi, net, os, path, process, querystring, streams
and string_decoder.

PR-URL: nodejs#31592
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
nodejs@e559842
made writable/readable computed with a legacy mode if the properties
are written to.

LazyTransform still unecessarily wrote to these properties causing a
performance regression.

Fixes: nodejs#31739

PR-URL: nodejs#31742
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@@ -1,4 +1,44 @@
# Code of Conduct
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@conordavenport this one should be left as is, with the link over to the nodejs/admin repo

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh right, thanks for pointing that out

PR-URL: nodejs#27517
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
@sam-github
Copy link
Contributor

I suggest all the guides be renamed to lower-case-with-minuses.md, it looks like two are still all-caps.

For every file that's renamed I suggest a git grep on its name because there are various TOCs and cross-links spread all over that link them together.

Thank you!

Trott and others added 2 commits February 13, 2020 22:21
Refs: nodejs#31727

PR-URL: nodejs#31728
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
There was an edge case where if _destroy calls the error callback
later than one tick the iterator would complete early and not
propgate the error.

PR-URL: nodejs#31314
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Minwoo Jung <nodecorelab@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: nodejs#31700
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Merged the CODE_OF_CONDUCT.md and doc/guides/contributing/coc.md
files into a single code of conduct file

Refs: nodejs#31741
Changed security_release_process.md to security-release-process.md
to stay consistent with file naming

Refs: nodejs#31741
Moved writing-and-running-benchmarks to doc/guides/ directory

Fixes: nodejs#31741
Updated updating-root-certs.md to maintaining-root-certs.md

Fixes: nodejs#31741
Moved COLLABORATOR_GUIDE, CPP_STYLE_GUIDE, and internal-api to
the appropriate directories

Fixes: nodejs#31741
Moved STYLE_GUIDE.md to guides/documentation-style.md

Fixes: nodejs#31741
Updated broken links after merging doc/guides/contributing/coc.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Issues and PRs related to the general management of the project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc/markdown file organization lacks coherence